home *** CD-ROM | disk | FTP | other *** search
/ Gold Medal Software 3 / Gold Medal Software - Volume 3 (Gold Medal) (1994).iso / bbsutils / gifcol27.arj / GIFCOLL.DOC < prev    next >
Text File  |  1994-02-20  |  20KB  |  406 lines
  1.                 PCBoard 15.1 GIF Collage Builder Command
  2.                         Version 2.7 Documentation
  3.  
  4.                            Earl Bonser, SysOp
  5.                             The GIFfer BBS
  6.                             12088 Anderson Rd.
  7.                             Suite #170
  8.                             Tampa, Fl. 33625
  9.  
  10.                             Fido (1:377/50)
  11.  
  12.                       (813) 969-2761 969-2956
  13.                             969-1829 969-1089
  14.                             960-7267 960-7348
  15.                             961-8292 961-8412
  16.  
  17.  
  18. I hate lengthly doc's as much as anyone, so this will be kept as short
  19. and to the point as possible.  The GIF Collage processor is a PCBoard
  20. PPE command that allows your users to create a small GIF file that
  21. contains up to 9 reduced images of other GIF files.  By using this
  22. command, they can get a preview of what the GIF files look like before
  23. spending time downloading the individual GIF's.  As the operator of a
  24. large graphics oriented BBS, I soon realized that a lot of GIF's are not
  25. what they are described to be and quite a few of them get renamed,
  26. resulting in duplicates.  It is also quite common for multiple people to
  27. scan the same picture, once again resulting in duplicates.  This command
  28. will help your users to weed out the ones that they already have and not
  29. waste their time and bytes downloading unwanted GIF's.
  30.  
  31. GIFCOLL has been tested under PCBoard 15.1, single node, multi node,
  32. DOS, OS/2 2.0, OS/2 2.1, DesqView and Lantastic.  It has been in use
  33. since June, 1993 and has yet to cause a system problem.  It is
  34. distributed as fully functional Shareware and may be posted or passed
  35. around in any way that you desire.  Registration of the GIFCOLL PPE will
  36. eliminate the startup delay screen and the irritating nag screen
  37. displayed when it ends.  Other than that, the Shareware and Registered
  38. versions are exactly the same.  A registered version will work on any
  39. PCBoard v15.x system, but will only act as a registered version on the
  40. BBS that it is registered to.  Feel free to pass your registered version
  41. on to anyone.
  42.  
  43. Installation of GIFCOLL is quick and simple.  The steps you should
  44. follow are given below.  You can get assistance if needed by contacting
  45. the author at The GIFfer BBS or sending Fido Netmail to Earl Bonser,
  46. Fido node (1:377/50).  Voice support is provided to registered users.
  47. SysOp's that have already installed a PCBoard 15.x PPE will breeze thru
  48. the installation in only a few minutes.
  49.  
  50.  
  51.  
  52.                               INSTALLATION
  53.  
  54.  
  55. If you are upgrading from a version prior to 2.2, see the UPGRADE.DOC
  56. file for quick installation information.
  57.  
  58. First a word for those of you running a dedicated single node system
  59. without the benefit of a multitasker.  You MUST have the DOS SHARE
  60. program loaded for this PPE to work.  It is reading a file being held
  61. by PCBoard and will always report that there are no files flagged for
  62. download if you don't have SHARE or an equilavent program loaded.  Just
  63. add the following line to your AUTOEXEC.BAT file.  If you are using a
  64. memory manager like QEMM or 386MAX, the SHARE program can be loaded high
  65. with no loss to the lower 640k.  I haven't tried it with the DOS 6.x
  66. memory manager, but it should work OK also.
  67.  
  68.              C:\DOS\SHARE.EXE /F:name_space /L:numlocks
  69.  
  70.    Rules for SHARE: /F: - If you do not specify the /F switch, name_space
  71.                           is set to 2048 bytes.  Each open files uses 11
  72.                           bytes plus its full file specification (disk
  73.                           drive name, path name and file name).  This
  74.                           2048 bytes can contain 27 files that use all
  75.                           63 characters available for the full file name.
  76.                           I use /F:4096 on my system and have never had
  77.                           a problem that I am aware of.
  78.  
  79.                     /L: - If you do not specify the /L switch, a default
  80.                           of 20 simultaneous file locks is allowed.  I
  81.                           have found it best to set this to a value that
  82.                           is 5 more than the FILES=nnn value set in your
  83.                           CONFIG.SYS file.  (ie: use /L:55 for FILES=50).
  84.  
  85.  
  86. Step 1: Move all of the files into a single hard drive directory.  If
  87.         you are running a multi node system and/or a Lan, this must be
  88.         a directory that all of the nodes can access.  You can create
  89.         a new directory just for the GIFCOLL system or move the files
  90.         into any existing directory.  The following files should be
  91.         included:
  92.                    GIF          a PCBoard HELP file.
  93.                    GIF.GER      a PCBoard HELP file in German
  94.                    GIFCOLL.PPE  the PCBoard command module
  95.                    GIFCOLG.PPE  the PCBoard command module in German
  96.                    GIFCOL0.EXE  a GIFCOLL sub command module
  97.                    GIFCOL1.EXE  a GIFCOLL sub command module
  98.                    GIFCOLL.DOC  this file
  99.                    GIFDESK.EXE  the GIFdesk collage builder utility
  100.                    GIFDESK.CMD  batch command string for GIFDesk
  101.                    REGISTER.TXT the registration document
  102.                    HISTORY.TXT  change history log
  103.                    UPGRADE.DOC  install info for upgrading to new version
  104.  
  105. Step 2: Copy or move the GIF file to your PCBoard Help directory.  The
  106.         PCBoard Help directory is defined in PCBSetup B (File Locations)
  107.         A (System Files & Directories) "Location of Help Files".  Also
  108.         copy the GIF.GER help file if you support the German language.
  109.  
  110. Step 3: If you are running a multi node system, ensure that each node
  111.         specifies a unique directory for it's temporary work files in
  112.         PCBSetup B (File Locations), A (System Files & Directories)
  113.         "Location of Temporary Work Files".
  114.  
  115. Step 4: Ensure that there is plenty of space in the drive you have
  116.         specified as the location for temporary work files in PCBSetup
  117.         (see step #3 above).  GIFColl uses this directory to copy up
  118.         to 9 GIF's at a time into when makeing the collage.  Use of a
  119.         RAM drive, which is quite common for this directory, will speed
  120.         up processing but will cause unpredictable results if it is not
  121.         large enough.  The average GIF file runs between 150-200k, so
  122.         a drive with at least 2.5 meg of free space will suffice in
  123.         most cases.  You really should allow for GIF's as large as 500k
  124.         if possible (9 x 500k = 4.5 meg).  This directory is empty when
  125.         the GIF command is started (PCBoard has not put any files in it)
  126.         and GIFColl removes the files it placed in it when it ends.
  127.  
  128. Step 5: Select a directory that will be used for callers to download the
  129.         collage files from.  GIFColl will place the collage files in
  130.         this directory after they are built and remove them after the
  131.         caller downloads them.  It MUST be a directory that is included
  132.         as a Download Path in PCBSetup for each conference and should
  133.         NOT be an indexed directory.  It's also best to make it one of
  134.         the first directories in the Download Paths list in case one
  135.         of the names generated for the temporary collage file ends up
  136.         duplicating the name of a file already posted on your BBS.
  137.  
  138. Step 6: Add the GIFCOLL PPE to your PCBoard CMD.LST file.  Go into
  139.         PCBSetup, B (File Locations), B (Configuration Files), move the
  140.         highlight bar to "Name/Loc of Default CMD.LST File" and press
  141.         F2.  The following screen will be displayed.  Enter a command
  142.         specification line for the GIFColl PPE similar to this:
  143.  
  144.         Command   Security  PPE/MNU File -or- Keystroke Replacement
  145.         =======   ========  ==========================================
  146.         GIF          21     D:\PCB\GIFCOLL\GIFCOLL.PPE  D:\TEMP
  147.  
  148.         GIF          21     D:\PCB\GIFCOLL\GIFCOLG.PPE  D:\TEMP
  149.                                                  |
  150.                                                  |Use this version
  151.                                                   for German language.
  152.  
  153.     These usage of the fields on this screen are:
  154.  
  155.      - Command:
  156.         It is not required that the command name be GIF, but it is
  157.         highly recommended since it a short name and is also the name
  158.         of the help file.  If you use another name, do NOT rename the
  159.         help file.  You can copy it to the command name you use if
  160.         you wish so users can enter a "H name" command, but the
  161.         GIFCOLL PPE expects to find it under the name GIF in your
  162.         PCBoard Help directory.
  163.  
  164.      - Security:
  165.         You can specify any security level you want.  This is the
  166.         MINIMUM security level required for a caller to be able to
  167.         use this command.  You may want to set it at a level only
  168.         you or a few selected callers can use while testing it.
  169.  
  170.      - PPE/MNU File -or- Keystroke Replacement:
  171.        The location and name of the GIFCOLL.PPE and the location/name
  172.        of the DLPATH.LST identified download directory that the collage
  173.        files will be placed in for the user to download.  The collage
  174.        files will be deleted after the user downloads them.  This must
  175.        be a fully qualified path name (include drive letter) and must
  176.        not include an ending backslash (\).  If you have a "hidden"
  177.        directory like most of us sneeky snakes, it's ideal for this.
  178.  
  179.  
  180. Step 7: Add the GIF command to the PCBoard User's & Sysop's Menu(s)
  181.         specified in PCBSetup for each conference you wish to make
  182.         the command available in (normally BRDM & BRDS).
  183.  
  184. Step 8: Add a SET GIFDESK=FILE command to your AUTOEXEC.BAT file.
  185.         If you don't want to reboot just to test GIFCOLL, you can just
  186.         enter SET GIFDESK=FILE from the DOS command line prompt after
  187.         adding the command to your AUTOEXEC.BAT file.
  188.  
  189. Step 9: Add the following line to your $$LOGOFF.BAT file(s).
  190.  
  191.    IF EXIST d:\temp\C%PCBNODE%*.GIF delete d:\temp\C%PCBNODE%*.GIF
  192.  
  193.         This will clean up any collage files that may be left in your
  194.         download directory under some circumstances.  If the caller
  195.         select the (G)oodbye option when downloading the collage file,
  196.         the PPE is never reentered and the collage file is not deleted.
  197.         This will insure that it is removed when the caller disconnects.
  198.  
  199.  
  200. Now you can test it.  You can test it in local mode (a local signon),
  201. but you will not see exactly what a remote caller will see.  The PCBoard
  202. shell operations done by the GIFCOLL.PPE cause the screen to clear each
  203. time that one of the sub programs is invoked.  It's best to test it by
  204. calling your BBS like your users do.  You will be able to see the
  205. displays easier if you do.
  206.  
  207. Use of the GIF command is simple and self explanitory.  Just go into
  208. some of your file lists and flag some GIF files as though you were going
  209. to download them.  Then go back to the main menu and enter GIF.  The
  210. GIFCOLL.PPE will give you an estimate on how long it will take to create
  211. the collage file(s) and, if it thinks it will take more than 2 minutes,
  212. will ask you if you want to continue.  It will then display information
  213. about the progress of the collage building process as it goes on.  If
  214. you have not flagged any GIF files for download before entering the GIF
  215. command, it will tell you so and display the GIF command Help file to
  216. instruct you on how to use it.
  217.  
  218. An entry is written to the PCBoard nodes log file each time that the GIF
  219. command is used.  This is done to assist you in keeping track of just
  220. how much the command is used and how usefull it is to your users.  There
  221. is another (sometimes irritating) feature that also lets you know how
  222. much the GIFCOLL PPE is being used.  The GIFDesk utility issues tones to
  223. your PC's speaker each time it has built a collage.  You will find this
  224. very irritating if you keep the hardware for your BBS close to or in
  225. your bedroom!  I hope to have this inconvience resolved in a future
  226. release of GIFCOLL.
  227.  
  228. The collage file(s) that are created for you are generated with random
  229. names (almost).  The format of the file names are:
  230.  
  231.        C1231234.GIF
  232.         ^^^||||----> A randomly generated number between 0-9999 that
  233.         ^^^          that will be incremented by 1 for each collage
  234.         ^^^          after the first one.
  235.         ^^^--------> The BBS node number.  The number of characters
  236.                      vary depending on the node number (ie: node 1
  237.                      is 1 character, node 123 is 3, etc.).
  238.  
  239. As you can see, it is possible for the generated name to duplicate the
  240. name of a file already posted on your BBS.  This, however, is very
  241. unlikley.  We recommend that the directory you specify for the collage
  242. files to be placed in for downloading be the first in your DLPATH.LST
  243. just in case it does happen to duplicate an existing file name.
  244.  
  245. Since the original reason I wrote the GIFCOLL.PPE was to help my callers
  246. not waste their time (and the BBS's time) and bytes getting something
  247. they really don't want, I make the collage files created by GIFCOLL free
  248. files on my BBS.  The time they use creating the collage files counts
  249. against their time limits, so it is not used by them as a way to get GIF
  250. pictures for free and beat the BBS restrictions on their sessions.  The
  251. GIFCOLL.PPE will also limit the number of GIF files it will process in a
  252. single invocation to 99.  If the user has flagged more than 99 GIF
  253. files, only the first 99 in the flag list will be processed.  This
  254. prevents 2 hours of building collage files for the guy that enters "FL
  255. *.GIF"!  He would probably hit his byte, time or file limit real quick
  256. anyway.  The way you set it up on your BBS is strictly your choice.  If
  257. you want to provide the collage files to your users without it counting
  258. against their byte or time/byte allotment, you can do the following:
  259.  
  260.     - Go into PCBSetup
  261.     - Select "File Locations" (B).
  262.     - Select "Configuration Files" (B).
  263.     - Move the highlight bar to "Name/Loc of FSEC file".
  264.     - Press F2 to edit the file as shown below.
  265.     - Press ESC to save the file.
  266.  
  267.            Drive \ Path             File Name    Sec      Password
  268.   =============================== ============= ===== =================
  269.   D:\TEMP\                        C*.GIF          20   NOTIME
  270.  
  271. These fields have the following meaning:
  272.  
  273.     - Drive\Path = The directory you specified as the dowload directory
  274.                    for the GIF collage files in CMD.LST.
  275.  
  276.     - File Name  = The name of the files that this entry applies to.
  277.                    If you wished to make the files free only on
  278.                    specific nodes, you could use a name mask that
  279.                    includes the node number (ie: C8*.GIF would make
  280.                    them free only on node #8).  You can also have
  281.                    multiple entries for multiple nodes if you wish.
  282.  
  283.     - Sec        = The lowest security level needed to have this setting
  284.                    apply to the caller.
  285.  
  286.     - Password   = A password of NOTIME means that downloading the
  287.                    file(s) is not counted as part of the session time
  288.                    and the download will not be counted against the
  289.                    callers download byte limit or file ratio.
  290.  
  291.                    A password of FREE means that downloading the file
  292.                    will not be charged against the callers download
  293.                    ratio.  The download time will still be deducted
  294.                    from the callers session time.
  295.  
  296.  
  297.                              COMMON ERRORS
  298.  
  299. - I enter the command and nothing happens, the BBS just goes back to
  300.   the main menu!
  301.  
  302.   You have 1 of 2 problems.  Either you didn't install the PPE in the
  303.   directory you entered in the CMD.LST file or you don't have enough
  304.   memory available (probably under DesqView) for the GIFCOLL shell
  305.   operations.  You need about 200k of memory available when in PCBoard.
  306.   Look in the bottom right corner of the local screen to see how much
  307.   memory is available.
  308.  
  309. - I keep getting displays and messages in the node log file saying
  310.   "Download path not specified on PPE command line." and "GIF Collage
  311.   Processor Environment error - Inform your SysOp".
  312.  
  313.   Kinda self explanitory, isn't it?  You have either failed to include
  314.   the download path name in your CMD.LST file or the path does not
  315.   exist.
  316.  
  317. - Not all of the GIF's I have flagged are being included in the collage
  318.   or an error message is issued when the collage file is being moved to
  319.   the download directory.
  320.  
  321.   You probably don't have enough space in your PCBoard temporary work
  322.   file directory.  If the collage is empty, there isn't even enough
  323.   space for 1 of the GIF files to be held temporarialy.  If you are
  324.   getting some, but not all, of the GIF files in the collage then
  325.   there probably is not enough space on the drive.  A caviot here.
  326.   I think that the GIFDESK utility may have a problem processing GIF
  327.   files that are constructed with the GIF89a format.  Some of GIF
  328.   files using the GIF89a format may not be placed in a collage built
  329.   by GIFDESK.
  330.  
  331.  
  332. - The collage files are fine, but I am also getting all of the GIF's
  333.   included in the collage when I do the download.
  334.  
  335.   You are not answering "N" to the "Download Flagged Files? (Y)"
  336.   question.  Remember, you flagged these files for DOWNLOAD for GIFCOLL
  337.   to use them.  They remain flagged and will be included in your download
  338.   by default if you don't answer "N" to this question.  The collage files
  339.   are added to the download list AFTER you are asked this question, so
  340.   an answer of "N" will not cause them to be lost.
  341.  
  342.  
  343. - A user aborts the download and then comes back to download the collage
  344.   files later but they are gone.
  345.  
  346.   That's correct.  The last thing that GIFCOLL does is clean up after
  347.   itself, including deletion of the collage files.  If you don't download
  348.   them when prompted to do so they are gone forever.
  349.  
  350.  
  351. - The GIF collage is being displayed on the local screen as the collage
  352.   is being built.
  353.  
  354.   The GIFDESK=FILE environment variable is not set.  Go back and look
  355.   at installation step #8 to remedy this.
  356.  
  357.  
  358. - My local screen keeps getting cleared when someone is using the GIF
  359.   command and I can't see what they are doing.
  360.  
  361.   PCBoard does this while shelled out to another program.  This occurs
  362.   in GIFColl when it is using some of it's sub-modules and when GIFDESK
  363.   is running.  All of the sub-modules are very quick, so this is kept
  364.   to a minimum.  It's actually nice to be able to see what GIFDESK is
  365.   doing since it gives you a progress report and shows the %complete
  366.   while building the collage.
  367.  
  368.  
  369. - The collage files are being left in the download directory and are
  370.   cluttering up my hard drive.
  371.  
  372.   You have not created or changed your $$LOGOFF.BAT as instructed in
  373.   installation step #9.
  374.  
  375.  
  376.  
  377.                               DISCLAIMER
  378.  
  379. GIFCOLL by Earl Bonser is released to the general public as Shareware.
  380.  
  381. GIFCOLL is provided AS IS without any warranty, expressed or implied.
  382. This includes without limitation the fitfulness to a particular purpose
  383. or application and any warranties of merchantability.  While I tried to
  384. be as thorough as possible while debugging GIFCOLL, I shall not be
  385. liable for any damages, whether direct, indirect, special, or
  386. consequential arising from a failure of GIFCOLL to operate in a manner
  387. desired by the user. I shall not be liable for any damage to data or
  388. property which may by caused directly or indirectly by use of GIFCOLL.
  389. The only thing that I can gurantee is that it will use some space on
  390. your hard drive when you install it.
  391.  
  392. In no event will I be liable to you for any damages, including any lost
  393. profits, lost savings or other incidental or consequential damages
  394. arising out of your use, ability or inability to use the program, or for
  395. any claim by any other party.
  396.  
  397.  
  398.  
  399.                                 CREDITS
  400.  
  401.  
  402. PCBOARD is a registered trademark of Clark Development Company, Inc.
  403.  
  404. GIFDESK is an excellent program released as freeware by Jay Wherley.
  405.  
  406.